Skip to content

chore: deprecate MkDocs docs#687

Draft
andreatgretel wants to merge 1 commit into
mainfrom
andreatgretel/chore/deprecate-mkdocs
Draft

chore: deprecate MkDocs docs#687
andreatgretel wants to merge 1 commit into
mainfrom
andreatgretel/chore/deprecate-mkdocs

Conversation

@andreatgretel

@andreatgretel andreatgretel commented May 20, 2026

Copy link
Copy Markdown
Contributor

Summary

Deprecates MkDocs as an active docs system on main now that Fern is the canonical Data Designer docs surface.

This PR does not modify the published gh-pages archive. The archive freeze and GitHub Pages redirect behavior live in #688.

Changes

  • Remove MkDocs source pages/assets, mkdocs.yml, and MkDocs-only docs workflows from main.
  • Convert docs preview and devnotes publishing follow-up to Fern-only behavior.
  • Drop MkDocs/mike/mkdocstrings docs dependencies and refresh uv.lock.
  • Keep docs/ for Fern support inputs only: notebook sources, generated Colab notebooks, docs scripts, and downloadable recipe assets.
  • Update current docs links to https://docs.nvidia.com/nemo/datadesigner.
  • Keep the Fern redirect mapping for legacy MkDocs/devnotes URLs in fern/docs.yml.

Archive Boundary

Attention Areas

  • docs/ intentionally remains as a support directory for Fern-linked assets and notebooks.
  • .github/workflows/docs-preview.yml now posts Fern previews only.
  • fern/docs.yml remains the active Fern-side bridge for legacy MkDocs/devnotes paths.

Testing

  • .venv/bin/ruff check --fix packages/data-designer/src/data_designer/interface/data_designer.py docs/notebook_source/*.py
  • .venv/bin/ruff format packages/data-designer/src/data_designer/interface/data_designer.py docs/notebook_source/*.py
  • make generate-colab-notebooks
  • make check-fern-docs (fern check: 0 errors, 1 warning)
  • git diff --check origin/main..HEAD
  • make test passes (not run locally; docs/CI cleanup only)
  • Unit tests added/updated (N/A - no runtime logic changes)
  • E2E tests added/updated (N/A - no runtime logic changes)

@github-actions

Copy link
Copy Markdown
Contributor

Fern preview: https://nvidia-preview-pr-687.docs.buildwithfern.com/nemo/datadesigner

Fern previews include the docs-website version archive with PR changes synced into latest. Notebook tutorials are rendered without execution outputs in previews.

@andreatgretel andreatgretel force-pushed the andreatgretel/chore/deprecate-mkdocs branch from 64bf1d7 to feafa25 Compare June 8, 2026 16:45
Signed-off-by: Andre Manoel <amanoel@nvidia.com>
@andreatgretel andreatgretel force-pushed the andreatgretel/chore/deprecate-mkdocs branch from feafa25 to 06dcf0f Compare June 8, 2026 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant